Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
remark-usage
Advanced tools
remark plugin to add a usage example to a readme.
npm:
npm install remark-usage
This section is rendered by this module from example.js.
Dependencies:
var fs = require('fs')
var remark = require('remark')
var usage = require('remark-usage') // This is changed from `./index.js` to `remark-usage`
Read and parse readme.md
:
var readme = fs.readFileSync('readme.md', 'utf-8')
var ast = remark()
.use(usage)
.parse(readme)
Log something with a language flag:
[**remark**][remark] plugin to add a [usage][] example to a readme.
Or without language:
## Install
Log something which is never captured:
function neverCalled() {
console.log('javascript', 'alert("test")')
}
Log something which isn’t captured because it’s not a string.
console.log(this)
remark().use(usage[, options])
Add example.js
to the Usage
section in a readme.
Removes the current content between the heading containing the text “usage”, and the next heading of the same (or higher) depth, and replaces it with the example.
The example is run as JavaScript.
Line comments are parsed as Markdown.
Calls to console.log()
are exposed as code blocks, containing the logged
values (optionally with a language flag).
It’s easiest to check out and compare example.js
with the above
Usage section.
cwd
example.js
options
options.cwd
Path to a directory containing a node module (string?
).
Used to infer name
, main
, and example
.
options.name
Name of the module (string?
).
Inferred from package.json
s name
property.
Used to rewrite require('.')
to require('some-name')
.
options.main
Path to the main script (string?
).
Resolved from package.json
s main
property (or index.js
).
Used to rewrite require('./index.js')
to require('some-name')
.
options.example
Path to the example script (string?
).
remark-usage
checks for docs/example.js
, doc/example.js
,
examples/index.js
, example/index.js
, and example.js
.
options.heading
Heading to look for (string?
, default: 'usage'
).
Wrapped in new RegExp('^(' + value + ')$', 'i');
.
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.
FAQs
remark plugin to add a usage example to your readme
The npm package remark-usage receives a total of 5,407 weekly downloads. As such, remark-usage popularity was classified as popular.
We found that remark-usage demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.